home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_apache2.idb / usr / freeware / apache2 / include / apr_uuid.h.z / apr_uuid.h
C/C++ Source or Header  |  2002-07-08  |  4KB  |  115 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  */
  54.  
  55. /**
  56.  * @file apr_uuid.h
  57.  * @brief APR UUID library
  58.  */
  59. #ifndef APR_UUID_H
  60. #define APR_UUID_H
  61.  
  62. #include "apr.h"
  63. #include "apr_errno.h"
  64.  
  65. #ifdef __cplusplus
  66. extern "C" {
  67. #endif /* __cplusplus */
  68.  
  69. /**
  70.  * @defgroup APR_UUID UUID Handling
  71.  * @ingroup APR
  72.  * @{
  73.  */
  74.  
  75. /**
  76.  * we represent a UUID as a block of 16 bytes.
  77.  */
  78.  
  79. typedef struct {
  80.     unsigned char data[16]; /**< the actual UUID */
  81. } apr_uuid_t;
  82.  
  83. /** UUIDs are formatted as: 00112233-4455-6677-8899-AABBCCDDEEFF */
  84. #define APR_UUID_FORMATTED_LENGTH 36
  85.  
  86.  
  87. /**
  88.  * Generate and return a (new) UUID
  89.  * @param uuid The resulting UUID
  90.  */ 
  91. APR_DECLARE(void) apr_uuid_get(apr_uuid_t *uuid);
  92.  
  93. /**
  94.  * Format a UUID into a string, following the standard format
  95.  * @param buffer The buffer to place the formatted UUID string into. It must
  96.  *               be at least APR_UUID_FORMATTED_LENGTH + 1 bytes long to hold
  97.  *               the formatted UUID and a null terminator
  98.  * @param uuid The UUID to format
  99.  */ 
  100. APR_DECLARE(void) apr_uuid_format(char *buffer, const apr_uuid_t *uuid);
  101.  
  102. /**
  103.  * Parse a standard-format string into a UUID
  104.  * @param uuid The resulting UUID
  105.  * @param uuid_str The formatted UUID
  106.  */ 
  107. APR_DECLARE(apr_status_t) apr_uuid_parse(apr_uuid_t *uuid, const char *uuid_str);
  108.  
  109. /** @} */
  110. #ifdef __cplusplus
  111. }
  112. #endif
  113.  
  114. #endif /* APR_UUID_H */
  115.